vcStatistics
vcStatistics allows you to create flow type and state based statistics as well as access the properties of a Statistics behavior and related simulation statistics.
See in: Overview
Module: vcBehaviors
Parent: vcBehavior
Children -
Referenced by: vcFlow.Statistics, vcSetRobotStatisticsStateStatement.Statistics, vcSetStatisticsFlowStatement.Statistics, vcSetStatisticsStateStatement.Statistics
Properties
Learn how to use properties here. The properties are also inherited from the parent class.
| Name | Type | Access | Description |
| AverageActivePeriodTime | Real | R | Gets the average amount of time a component was in one of its defined states. |
| BlockedPercentage | Real | R | Gets the amount of time a component spent in a blocked state, for example capacity issue, as a percentage of total time. |
| BreakPercentage | Real | R | Gets the amount of time a component spent in a broken state as a percentage of total time. |
| BusyPercentage | Real | R | Gets the amount of time a component spent in a busy state or was being used as a percentage of total time. |
| ComponentMaxCount | Integer | R | Gets the maximum number of components that have been contained in a component at any given time. |
| ComponentMaxTime | Real | R | Gets the maximum amount of time a component spent contained in a component. |
| ComponentMinCount | Integer | R | Gets the minimum number of components that been contained in a component at any given time. |
| ComponentMinTime | Real | R | Gets the minimum amount of time a component spent contained in a component. |
| ComponentsArrived | Integer | R | Gets the total number of components that have been transferred into a component. |
| ComponentsAverageTime | Real | R | Gets the average amount of time components have spent in a component. |
| ComponentsCurrent | Integer | R | Gets the total number of components currently contained in a component. |
| ComponentsDeparted | Integer | R | Gets the total amount of components that have been transferred out of a component. |
| FailedPercentage | Real | R | Gets the amount of time a component spent in a failed state as a percentage of total time. |
| IdlePercentage | Real | R | Gets the amount of time a component spent in an idle state as a percentage of total time. |
| IntervalBlockedPercentage | Real | R | Gets the amount of time a component spent in a blocked state during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalBreakPercentage | Real | R | Gets the amount of time a component spent in a broken state during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalBusyPercentage | Real | R | Gets the amount of time a component spent in a busy state during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalFailedPercentage | Real | R | Gets the amount of time a component spent in a failed state during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalIdlePercentage | Real | R | Gets the amount of time a component spent in a failed state during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalRepairPercentage | Real | R | Gets the amount of time a component spent in an idle state during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalSetupPercentage | Real | R | Gets the amount of time a component spent in a setup state, for example warm up time, during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalTotalStateTime | Real | R | Gets the total amount of time a component was in one of its defined states during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| IntervalUtilization | Real | R | Gets the amount of time a component was busy during the last recorded simulation interval (which by default is every 60.0 seconds) as a percentage (busy state/100 * 100%). See vcStatisticsManager for more information on how to change interval. |
| PartsAverageCount | Real | R | Gets the average amount of components that have been contained in a component. |
| PartsAverageTime | Real | R | Gets the average amount of time components spent in a component. |
| PartsCurrent | Integer | R | Gets the current amount of components contained in a component. |
| PartsEntered | Integer | RW | Gets or sets the number of components that have been transferred into a component. Generally, this property is set to reset a count or collect from the start of a new process. |
| PartsExited | Integer | RW | Gets or sets the number of components that have been transferred out of a component. Generally, this property is set to reset a count or collect from the start of a new process. |
| PartsIntervalAverageCount | Real | R | Gets the average amount of components that have been contained in a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalAverageTime | Real | R | Gets the average amount of time components spent in a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalCurrent | Integer | R | Gets the current amount of components contained in a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalEntered | Integer | R | Gets the number of components that have been transferred into a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalExited | Integer | R | Gets the number of components that have been transferred out of a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalMaxCount | Integer | R | Gets the maximum number of components that have been contained in a component at any given time during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalMaxTime | Real | R | Gets the maximum amount of time a component has spent in a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalMinCount | Integer | R | Gets the minimum number of components that have been contained in a component at any given time during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalMinTime | Real | R | Gets the minimum amount of time a component has spent in a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalTotalTime | Real | R | Gets sum total of the amount of time each component had spent in a component during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsIntervalUtilization | Real | R | Gets the percentage of a component's capacity being utilized during the last recorded simulation interval, which by default is every 60.0 seconds. See vcStatisticsManager for more information on how to change interval. |
| PartsMaxCount | Integer | R | Gets the maximum number of components that have been contained in a component at any given time. |
| PartsMaxTime | Real | R | Gets the maximum amount of time a component has spent in a component. |
| PartsMinCount | Integer | R | Gets the minimum number of components that have been contained in a component at any given time. |
| PartsMinTime | Real | R | Gets the minimum amount of time a component has spent in a component. |
| PartsTotalTime | Real | R | Gets sum total of the amount of time each component had spent in a component, for example the duration of each component on a conveyor added together. |
| PartsUtilization | Real | R | Gets the percentage of a component's capacity being utilized: number of parts divided by component's capacity. |
| RepairPercentage | Real | R | Gets the amount of time a component spent in a repair state as a percentage of total time. Scripting can be used to set repair time and include time waiting for a repair. |
| SetupPercentage | Real | R | Gets the amount of time a component spent in a setup state, for example warm up time, as a percentage of total time. |
| State | String | RW | Gets or sets the current state of component. Use the States property to get an indication of available states in component. |
| States | list[tuple[String, vcStatisticsState]] | RW | Gets or sets a list of defined states mapped to system states. A state must be mapped to a system state. |
| SystemStates | list[tuple[String, vcStatisticsState]] | R | Gets a list of available system states, which provides system state description and type. |
| TotalStateTime | Real | R | Gets the total amount of time a component was in one of its defined states based on total time. |
| Utilization | Real | R | Gets the amount of time a component was busy during a simulation as a percentage (busy state/100 * 100%). |
Methods
Learn how to use methods here. The methods are also inherited from the parent class.
| Name | Return Type | Parameters | Description |
| flowEnter | None | vcComponent component | Manually records a given component transferring into component. Parameters: component (vcComponent): Component to record. |
| flowLeave | None | vcComponent component | Manually records a given component transferring out of component. Parameters: component (vcComponent): Component to record. |
| getIntervalPercentage | Real | String state | Returns the accumulated time of a given state as a percentage of the last recorded interval during a simulation.See moreParameters: state (String): State name. Returns: double: The accumulated time of a given state as a percentage of the last recorded interval during a simulation. Exceptions: ArgumentError: When given state doesnt exist in the list of known states. |
| getPercentage | Real | String state | Returns the accumulated time of a given state as a percentage of total time at the time of call.See moreParameters: state (String): State name. Returns: double: The accumulated time of a given state as a percentage of total time at the time of call. Exceptions: ArgumentError: When given state doesnt exist in the list of known states. |
| getSystemIntervalPercentage | Real | vcStatisticsState systemState | Returns the accumulated time of a given systemState as a percentage of the last recorded interval during a simulation.See moreParameters: systemState (vcStatisticsState): System state. Returns: double: The accumulated time of a given systemState as a percentage of the last recorded interval during a simulation. |
| getSystemPercentage | Real | vcStatisticsState systemState | Returns the accumulated time of a given systemState as a percentage of total time at the time of call.See moreParameters: systemState (vcStatisticsState): System state. Returns: double: The accumulated time of a given systemState as a percentage of total time at the time of call. |
| getSystemTime | Real | vcStatisticsState systemState | Returns the accumulated time of a given systemState at the time of call.See moreParameters: systemState (vcStatisticsState): System state. Returns: double: The accumulated time of a given systemState at the time of call. |
| getTime | Real | String state | Returns the accumulated time of a given state at the time of call.See moreParameters: state (String): State name. Returns: double: The accumulated time of a given state at the time of call. Exceptions: ArgumentError: When given state doesnt exist in the list of known states. |
| warmupCompleted | None | None | Marks the completion/end of a component's warm up period, thereby setting all statistics to zero at the time of call.See moreFor example, a component can be configured to run a delay or a certain number of time consuming tasks at the start of a simulation. When this method is called, warm up time is calculated from simulation start to time of call. |
Events
Learn how to use events here. The events are also inherited from the parent class.
| Name | Parameters | Description |
| OnFlowChange | vcStatistics statistics, float time, bool incoming, vcNode component | Triggered when a component is transferred into or out of a component.See moreParameters: statistics (vcStatistics): Object that recorded the event. time (float): Simulation time when flow change occurred. incoming (bool): True when component transfers in and False when component transfers out of component. component (vcNode): Transferred component. |
| OnStateChange | vcStatistics statistics, float time, int state, vcNode component | Triggered when the state change occurs in a component. The state argument is the new state or system state of component. Refer to States or SystemStates property values as needed. See moreParameters: statistics (vcStatistics): Statistics behavior that recorded the event. time (float): Simulation time when state change occurred. state (int): The new state or system state of component. component (vcNode): The component. |